---
layout: m1x_soap
title: Attribute Info
---

				    
<h3><a name="product_attribute.info-Module%3AProductAttributesAPI"></a>Module: Product Attributes API</h3>

<h4><a name="product_attribute.info-Resource%3Aproductattribute"></a>Resource: product_attribute</h4>


<h5><a name="product_attribute.info-Method%3A"></a>Method: </h5>
<ul>
	<li>product_attribute.info (SOAP V1)</li>
	<li>catalogProductAttributeInfo (SOAP V2)</li>
</ul>


<p>Allows you to get full information about a required attribute with the list of options.</p>

<p><b>Arguments:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> string </td>
<td> attribute </td>
<td> Attribute code or ID </td>
</tr>
</tbody></table>


<p><b>Return:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> result </td>
<td> Array of catalogProductAttributeEntity </td>
</tr>
</tbody></table>


<p>The <b>catalogProductAttributeEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> attribute_id </td>
<td> Attribute ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> attribute_code <br class="atl-forced-newline" /> </td>
<td> Attribute code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> frontend_input <br class="atl-forced-newline" /> </td>
<td> Attribute type <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> scope <br class="atl-forced-newline" /> </td>
<td> Attribute scope </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> default_value <br class="atl-forced-newline" /> </td>
<td> Attribute default value </td>
</tr>
<tr>
<td> int </td>
<td> is_unique <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute is unique </td>
</tr>
<tr>
<td> int </td>
<td> is_required <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute is required <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> ArrayOfString </td>
<td> apply_to <br class="atl-forced-newline" /> </td>
<td> Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard' <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> is_configurable <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute can be used for configurable products <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> is_searchable <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute can be used in Quick Search <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> is_visible_in_advanced_search <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute can be used in Advanced Search <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> is_comparable <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute can be compared on the frontend <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> is_used_for_promo_rules <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute can be used for promo rules <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> is_visible_on_front <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute is visible on the frontend </td>
</tr>
<tr>
<td> int </td>
<td> used_in_product_listing <br class="atl-forced-newline" /> </td>
<td> Defines whether the attribute can be used in product listing <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> associativeArray <br class="atl-forced-newline" /> </td>
<td> additional_fields <br class="atl-forced-newline" /> </td>
<td> Array of additional fields </td>
</tr>
<tr>
<td> array </td>
<td> options <br class="atl-forced-newline" /> </td>
<td> Array of catalogAttributeOptionEntity </td>
</tr>
<tr>
<td> array </td>
<td> frontend_label <br class="atl-forced-newline" /> </td>
<td> Array of catalogProductAttributeFrontendLabel </td>
</tr>
</tbody></table>


<p>The <b>catalogAttributeOptionEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> label <br class="atl-forced-newline" /> </td>
<td> Text label </td>
</tr>
<tr>
<td> string </td>
<td> value <br class="atl-forced-newline" /> </td>
<td> Option ID </td>
</tr>
</tbody></table>


<p>The <b>catalogProductAttributeFrontendLabelEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> store_id <br class="atl-forced-newline" /> </td>
<td> Store ID </td>
</tr>
<tr>
<td> string </td>
<td> label <br class="atl-forced-newline" /> </td>
<td> Text label </td>
</tr>
</tbody></table>


<p>The <b>AdditionaFieldsEntity</b> array of additional fields for the <b>text</b> type is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> frontend_class </td>
<td> Input Validation for Store Owner. Possible values: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9)) </td>
</tr>
<tr>
<td> boolean </td>
<td> is_html_allowed_on_front </td>
<td> Defines whether the HTML tags are allowed on the frontend </td>
</tr>
<tr>
<td> boolean </td>
<td> used_for_sort_by </td>
<td> Defines whether it is used for sorting in product listing </td>
</tr>
</tbody></table>


<p>The <b>AdditionaFieldsEntity</b> array of additional fields for the <b>text area</b> type is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> boolean </td>
<td> is_wysiwyg_enabled </td>
<td> Enable WYSIWYG flag </td>
</tr>
<tr>
<td> boolean </td>
<td> is_html_allowed_on_front </td>
<td> Defines whether the HTML tags are allowed on the frontend <br class="atl-forced-newline" /> </td>
</tr>
</tbody></table>


<p>The <b>AdditionaFieldsEntity</b> array of additional fields for the <b>date</b>和<b>boolean</b> types is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> boolean </td>
<td> used_for_sort_by </td>
<td> Defines whether it is used for sorting in product listing <br class="atl-forced-newline" /> </td>
</tr>
</tbody></table>


<p>The <b>AdditionaFieldsEntity</b> array of additional fields for the <b>multiselect</b> type is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> boolean </td>
<td> is_filterable </td>
<td> Defines whether it used in layered navigation </td>
</tr>
<tr>
<td> boolean </td>
<td> is_filterable_in_search </td>
<td> Defines whether it is used in search results layered navigation </td>
</tr>
<tr>
<td> int </td>
<td> position </td>
<td> Position </td>
</tr>
</tbody></table>


<p>The <b>AdditionaFieldsEntity</b> array of additional fields for the <b>select</b>和<b>price</b> types is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> boolean </td>
<td> is_filterable </td>
<td> Defines whether it used in layered navigation <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> boolean </td>
<td> is_filterable_in_search </td>
<td> Defines whether it is used in search results layered navigation <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> position </td>
<td> Position </td>
</tr>
<tr>
<td> boolean </td>
<td> used_for_sort_by </td>
<td> Defines whether it is used for sorting in product listing <br class="atl-forced-newline" /> </td>
</tr>
</tbody></table>


<p><b>Faults:</b></p>


<table><tbody>
<tr>
<th> Fault Code </th>
<th> Fault Message </th>
</tr>
<tr>
<td> 101 </td>
<td> Requested attribute not found. </td>
</tr>
</tbody></table>


<h4><a name="product_attribute.info-Examples"></a>Examples</h4>

<h5><a name="product_attribute.info-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires api authentification,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');

$result = $client-&gt;call($session, 'product_attribute.info', '11');
var_dump ($result);

// If you don't need the session anymore
//$client-&gt;endSession($session);</pre>
		</div>
</div></div>

<h5><a name="product_attribute.info-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;catalogProductAttributeInfo($sessionId, '11');
var_dump($result);</pre>
		</div>
</div></div>


<h5><a name="product_attribute.info-ResponseExampleSOAPV1"></a>Response Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: java; gutter: false">array
  'attribute_id' =&gt; string '11' (length=3)
  'attribute_code' =&gt; string 'new_special_price' (length=17)
  'frontend_input' =&gt; string 'text' (length=4)
  'default_value' =&gt; null
  'is_unique' =&gt; string '0' (length=1)
  'is_required' =&gt; string '0' (length=1)
  'apply_to' =&gt;
    array
      empty
  'is_configurable' =&gt; string '0' (length=1)
  'is_searchable' =&gt; string '0' (length=1)
  'is_visible_in_advanced_search' =&gt; string '0' (length=1)
  'is_comparable' =&gt; string '0' (length=1)
  'is_used_for_promo_rules' =&gt; string '0' (length=1)
  'is_visible_on_front' =&gt; string '0' (length=1)
  'used_in_product_listing' =&gt; string '0' (length=1)
  'frontend_label' =&gt;
    array
      0 =&gt;
        array
          'store_id' =&gt; int 0
          'label' =&gt; string 'special price' (length=13)
      1 =&gt;
        array
          'store_id' =&gt; int 2
          'label' =&gt; string 'special price' (length=13)
  'scope' =&gt; string 'store' (length=5)
  'additional_fields' =&gt;
    array
      'frontend_class' =&gt; null
      'is_html_allowed_on_front' =&gt; string '1' (length=1)
      'used_for_sort_by' =&gt; string '0' (length=1)</pre>
		</div>
</div></div>

				    
Create the Magento文件系统所有者                   			    
